//
// * Copyright (c) 2002-2009 "Neo Technology,"
// *     Network Engine for Objects in Lund AB [http://neotechnology.com]
// *
// * This file is part of Neo4j.
// * 
// * Neo4j is free software: you can redistribute it and/or modify
// * it under the terms of the GNU Affero General Public License as
// * published by the Free Software Foundation, either version 3 of the
// * License, or (at your option) any later version.
// * 
// * This program is distributed in the hope that it will be useful,
// * but WITHOUT ANY WARRANTY; without even the implied warranty of
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// * GNU Affero General Public License for more details.
// * 
// * You should have received a copy of the GNU Affero General Public License
// * along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
namespace org.neo4j.kernel.impl.transaction.xaframework
{

	using XAResource = javax.transaction.xa.XAResource;

///
/// <summary> * <CODE>XaConnection</CODE> holds the <CODE>XAResource</CODE> used by the
/// * transaction manager to control the work done on the resource in a global
/// * transaction. Normally you add your "work like" methods in the implementing
/// * class.
/// * <p>
/// * Don't forget to enlist and delist the resource with the transaction manager
/// * when work is beeing done
/// *  </summary>
/// * <seealso cref= XaConnectionHelpImpl </seealso>
/// 
	public interface XaConnection
	{
///    
///     <summary> * Returns the <CODE>XAResource</CODE> held by this <CODE>XaConnection</CODE>.
///     *  </summary>
///     * <returns> The resource associated with this connection </returns>
///     
		XAResource getXaResource();

///    
///     <summary> * Destroys this connection and depending on <CODE>XAResource</CODE>
///     * implementation the work done on the resource will be rolled back, saved
///     * or committed (may also depend on transactional state).
///     * <p>
///     * This method is only valid to call once and there after it is illegal to
///     * invoke <CODE>getXaResource</CODE> or any other method that creates
///     * transactions or performs work using the <CODE>XAResource</CODE>. </summary>
///     
		void destroy();
	}
}